<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class LIST_Email</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=utf-8'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class LIST_Email</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This extended CI_Email library provides new functions to handle emails with smarty templates.</p>
	<ul class="tags">
				<li><span class="field">author:</span> Andrej Jursa</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_libraries---LIST_Email.php.html">/libraries/LIST_Email.php</a> (line <span class="field"><a href="../__filesource/fsource_LIST_Libraries__librariesLIST_Email.php.html#a12">12</a></span>)
		</p>
		
				
		<pre>CI_Email
   |
   --LIST_Email</pre>
	
			</div>
</div>



	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<div class="var-summary">
																																<div class="var-title">
					<span class="var-type">CodeIgniter</span>
					<a href="#$CI" title="details" class="var-name">$CI</a>
				</div>
																<div class="var-title">
					<span class="var-type">array<string></span>
					<a href="#$default_addresses" title="details" class="var-name">$default_addresses</a>
				</div>
											</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																												
												<div class="method-definition">
											<span class="method-result">LIST_Email</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
											([<span class="var-type">array<mixed></span>&nbsp;<span class="var-name">$config</span> = <span class="var-default">array()</span>])
									</div>
																<div class="method-definition">
											<span class="method-result"><a href="../LIST_Libraries/LIST_Email.html">LIST_Email</a></span>
										<a href="#build_message_body" title="details" class="method-name">build_message_body</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$template</span>, [<span class="var-type">array<mixed></span>&nbsp;<span class="var-name">$tpl_data</span> = <span class="var-default">array()</span>])
									</div>
																<div class="method-definition">
											<span class="method-result"><a href="../LIST_Libraries/LIST_Email.html">LIST_Email</a></span>
										<a href="#from_system" title="details" class="method-name">from_system</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result"><a href="../LIST_Libraries/LIST_Email.html">LIST_Email</a></span>
										<a href="#reply_to_system" title="details" class="method-name">reply_to_system</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#_get_alt_message" title="details" class="method-name">_get_alt_message</a>
										()
									</div>
								</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="var$CI" id="$CI"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">CodeIgniter</span>
			<span class="var-name">$CI</span>
						(line <span class="line-number"><a href="../__filesource/fsource_LIST_Libraries__librariesLIST_Email.php.html#a17">17</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">var:</span> CodeIgniter object.</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$default_addresses" id="$default_addresses"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">array<string></span>
			<span class="var-name">$default_addresses</span>
						(line <span class="line-number"><a href="../__filesource/fsource_LIST_Libraries__librariesLIST_Email.php.html#a21">21</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">var:</span> default e-mail addresses.</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number"><a href="../__filesource/fsource_LIST_Libraries__librariesLIST_Email.php.html#a28">28</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Extended constructor, which will first load default e-mail configuration from config file and then merge it with provided custom configuration.</p>
<p class="description"><p>It will also load all default addresses to internal variable.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">LIST_Email</span>
		<span class="method-name">
			__construct
		</span>
					([<span class="var-type">array<mixed></span>&nbsp;<span class="var-name">$config</span> = <span class="var-default">array()</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">array<mixed></span>
				<span class="var-name">$config</span><span class="var-description">: configuration options.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodbuild_message_body" id="build_message_body"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">build_message_body</span> (line <span class="line-number"><a href="../__filesource/fsource_LIST_Libraries__librariesLIST_Email.php.html#a75">75</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Will construct and set html message by provided smarty template code or smarty template file.</p>
	<ul class="tags">
				<li><span class="field">return:</span> this object for method chaining.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../LIST_Libraries/LIST_Email.html">LIST_Email</a></span>
		<span class="method-name">
			build_message_body
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$template</span>, [<span class="var-type">array<mixed></span>&nbsp;<span class="var-name">$tpl_data</span> = <span class="var-default">array()</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$template</span><span class="var-description">: can be template code or template file (file must be prepended by file: prefix, ie. 'file:emails/new_user.tpl').</span>			</li>
					<li>
				<span class="var-type">array<mixed></span>
				<span class="var-name">$tpl_data</span><span class="var-description">: template data.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodfrom_system" id="from_system"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">from_system</span> (line <span class="line-number"><a href="../__filesource/fsource_LIST_Libraries__librariesLIST_Email.php.html#a44">44</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set mail from parameter to the one stored in config.php file.</p>
	<ul class="tags">
				<li><span class="field">return:</span> this object for method chaining.</li>
				<li><span class="field">throws:</span> Exception when there is error in configuration (ie. missing/null array indexes or invalid e-mail address).</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../LIST_Libraries/LIST_Email.html">LIST_Email</a></span>
		<span class="method-name">
			from_system
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodreply_to_system" id="reply_to_system"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">reply_to_system</span> (line <span class="line-number"><a href="../__filesource/fsource_LIST_Libraries__librariesLIST_Email.php.html#a59">59</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set mail reply to parameter to the one stored in config.php file.</p>
	<ul class="tags">
				<li><span class="field">return:</span> this object for method chaining.</li>
				<li><span class="field">throws:</span> Exception when there is error in configuration (ie. missing/null array indexes or invalid e-mail address).</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../LIST_Libraries/LIST_Email.html">LIST_Email</a></span>
		<span class="method-name">
			reply_to_system
		</span>
				()
			</div>
	
		
			
	</div>
<a name="method_get_alt_message" id="_get_alt_message"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">_get_alt_message</span> (line <span class="line-number"><a href="../__filesource/fsource_LIST_Libraries__librariesLIST_Email.php.html#a86">86</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			_get_alt_message
		</span>
				()
			</div>
	
		
			
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Fri, 13 Sep 2013 12:32:38 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.4</a>
	</p>
	</div></body>
</html>